Add wiring reference docs#315
Conversation
for more information, see https://pre-commit.ci
|
Thansk @chrishalcrow Looking great! I think I would add it to a separate |
Sounds reasonable. I had added a new docs page. Instead, do you think it should just live on the repo without documentation? Or maybe just a link to the repo folder on one of the other pages (like here: https://probeinterface.readthedocs.io/en/latest/examples/ex_11_automatic_wiring.html)? |
|
Is it normal to get a 404 page not found when clicking on the links? Or is this because the build is from the PR? |
It's because it's from the PR |
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #315 +/- ##
==========================================
+ Coverage 89.46% 89.58% +0.11%
==========================================
Files 11 12 +1
Lines 1899 1939 +40
==========================================
+ Hits 1699 1737 +38
- Misses 200 202 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@alejoe91 @samuelgarcia all the |
|
Merci infiniment Chris. |
3 participants
Hello,
Here's a draft for adding reference docs for the wiring pathways from
wirings.py. Idea is to add a.pdfand.xlsxfor each wiring, so it's easy for users/maintainers to check wiring when we need. Here I've included one of the seven wirings.The spreadsheet contains all the intermediate steps for the wiring, while the pdf contains links to the company websites and figures so that you can re-generate the spreadsheet yourself.
Some design choices:
docs/imgsresources/wiring_referencesbut maybe there's a better place?automatic wiringdoc pageI've collated all the data, so just need some feedback on design/etc before making all the pdfs.
Don't think you'll be able to see the files in the draft docs, so here they are:
ASSY-77>Adpt.A64-Om32_2x-sm-NN>RHD2164.pdf
ASSY-77>Adpt.A64-Om32_2x-sm-NN>RHD2164.xlsx